Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve mapper documentation via adding user-context #3000

Merged
merged 2 commits into from
Jul 17, 2024
Merged

docs: improve mapper documentation via adding user-context #3000

merged 2 commits into from
Jul 17, 2024

Conversation

reubenmiller
Copy link
Contributor

@reubenmiller reubenmiller commented Jul 16, 2024 •
edited
Loading

Proposed changes

This PR was created after an interaction with a user trying to use thin-edge.io with AWS IoT Core. Due to the complexity of setting the AWS policy (as the policy needs to be changed to include the user's AWS IoT settings), it lead to invalid settings being used.

Adding user context to the getting started and "connect" documentation to allow users to provide their URLs so that the commands will be updated to use the given user context to make it easier to use and understand (and hopefully less user-errors).

The user-context functionality is provided by new React JS components which are included in thin-edge/tedge-docs#78

Features

  • User values are persisted in the browser's local storage
  • Sensible default values are show to give the user a sense of what a value could look like
  • User's can collapse the user-context form, and this preference will also be persisted in the browser's local storage

Example

At the top of the page (where the user context has been added to), shows a form which the user can edit add add the relevant values such as URLs, account details etc.

image

Afterwards, the code blocks (which are wrapped in <UserContext> components), below shows an example given the pre-filled user context.

image

Types of changes

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (general improvements like code refactoring that doesn't explicitly fix a bug or add any new functionality)
  • Documentation Update (if none of the other choices apply)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Paste Link to the issue

#2999

Checklist

  • I have read the CONTRIBUTING doc
  • I have signed the CLA (in all commits with git commit -s)
  • I ran cargo fmt as mentioned in CODING_GUIDELINES
  • I used cargo clippy as mentioned in CODING_GUIDELINES
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

@reubenmiller reubenmiller temporarily deployed to Test Pull Request July 16, 2024 15:23 — with GitHub Actions Inactive
@reubenmiller reubenmiller added documentation Improvements or additions to documentation theme:c8y Theme: Cumulocity related topics theme:aws Theme: AWS cloud related topics theme:az Theme: Azure IoT related topics labels Jul 16, 2024
gligorisaev
gligorisaev reviewed Jul 17, 2024
View reviewed changes
Copy link
Contributor

@gligorisaev gligorisaev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • The changes introduced in this PR significantly enhance the quality and usability of the thin-edge.io documentation.

  • The updated and new content is accurate, comprehensive, and well-structured, providing a better resource for users.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 17, 2024 •
edited
Loading

Robot Results

✅ Passed ❌ Failed ⏭️ Skipped Total Pass % ⏱️ Duration
476 0 3 476 100 1h12m51.826104999s

didier-wenzek
didier-wenzek reviewed Jul 17, 2024
View reviewed changes
Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though I am not for the idea of inciting the users to copy/paste sudo commands, I have to acknowledge that the user experience is great, only having to adapt a few settings to see personalized examples.

docs/src/start/getting-started.md Show resolved Hide resolved
docs/src/start/connect-aws.md Show resolved Hide resolved
didier-wenzek
didier-wenzek approved these changes Jul 17, 2024
View reviewed changes
Copy link
Contributor

@didier-wenzek didier-wenzek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@reubenmiller reubenmiller temporarily deployed to Test Pull Request July 17, 2024 14:05 — with GitHub Actions Inactive
@reubenmiller reubenmiller enabled auto-merge July 17, 2024 14:13
@reubenmiller reubenmiller temporarily deployed to Test Pull Request July 17, 2024 14:36 — with GitHub Actions Inactive
@reubenmiller reubenmiller added this pull request to the merge queue Jul 17, 2024
Merged via the queue into thin-edge:main with commit 837073b Jul 17, 2024
31 checks passed
@reubenmiller reubenmiller deleted the docs-user-context branch July 18, 2024 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gligorisaev gligorisaev gligorisaev left review comments

@didier-wenzek didier-wenzek didier-wenzek approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation theme:aws Theme: AWS cloud related topics theme:az Theme: Azure IoT related topics theme:c8y Theme: Cumulocity related topics
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@reubenmiller @didier-wenzek @gligorisaev